使用 tableflip 实现应用的优雅热升级

tableflip 应用举例

接下来我们设计一个集成 tableflip 的简单 http server，完整代码如下：

package main

import (
    "context"
    "fmt"
    "log"
    "net/http"
    "os"
    "os/signal"
    "syscall"
    "time"

    "github.com/cloudflare/tableflip"
)

// 当前程序的版本
const version = "v0.0.1"

func main() {
    upg, err := tableflip.New(tableflip.Options{})
    if err != nil {
        panic(err)
    }
    defer upg.Stop()

    // 为了演示方便，为程序启动强行加入 1s 的延时，并在日志中附上进程 pid
    time.Sleep(time.Second)
    log.SetPrefix(fmt.Sprintf("[PID: %d] ", os.Getpid()))

    // 监听系统的 SIGHUP 信号，以此信号触发进程重启
    go func() {
        sig := make(chan os.Signal, 1)
        signal.Notify(sig, syscall.SIGHUP)
        for range sig {
            // 核心的 Upgrade 调用
            err := upg.Upgrade()
            if err != nil {
                log.Println("Upgrade failed:", err)
            }
        }
    }()

    // 注意必须使用 upg.Listen 对端口进行监听
    ln, err := upg.Listen("tcp", ":8080")
    if err != nil {
        log.Fatalln("Can't listen:", err)
    }

    // 创建一个简单的 http server，/version 返回当前的程序版本
    mux := http.NewServeMux()
    mux.HandleFunc("/version", func(rw http.ResponseWriter, r \*http.Request) {
        log.Println(version)
        rw.Write([]byte(version + "\\n"))
    })
    server := http.Server{
        Handler: mux,
    }

    // 照常启动 http server
    go func() {
        err := server.Serve(ln)
        if err != http.ErrServerClosed {
            log.Println("HTTP server:", err)
        }
    }()

    if err := upg.Ready(); err != nil {
        panic(err)
    }
    \<-upg.Exit()

    // 给老进程的退出设置一个 30s 的超时时间，保证老进程的退出
    time.AfterFunc(30\*time.Second, func() {
        log.Println("Graceful shutdown timed out")
        os.Exit(1)
    })

    // 等待 http server 的优雅退出
    server.Shutdown(context.Background())
}

上面的代码实现了一个返回当前 version 的 http server，我们还在启动过程中插入了 1s 的延时来拉长进程的初始化时间，以观察升级过程中服务是否依旧可用。

编译并运行之：

go build -o demo main.go
./demo

使用 curl 模拟一些客户端请求（10 qps）：

while true; do curl http://localhost:8080/version; sleep 0.1; done

...
[PID: 18939] 2021/07/04 15:02:47 v0.0.1
[PID: 18939] 2021/07/04 15:02:47 v0.0.1
[PID: 18939] 2021/07/04 15:02:47 v0.0.1
[PID: 18939] 2021/07/04 15:02:48 v0.0.1
...

然后，我们对应用进行了一些升级，将版本号修改为 v0.0.2，并重新编译程序：

go build -o demo main.go

最后，来试试优雅的热重启是否奏效吧！

kill -s HUP 18939

...
[PID: 19306] 2021/07/04 15:04:57 v0.0.2
[PID: 19306] 2021/07/04 15:04:57 v0.0.2
[PID: 19306] 2021/07/04 15:04:57 v0.0.2
[PID: 19306] 2021/07/04 15:04:57 v0.0.2
...

可见，客户端完全不会受服务端的升级和重启的影响，我们的应用实现了优雅升级！

...
v0.0.1
v0.0.1
v0.0.2
v0.0.2
v0.0.2
...

总结